Skip to main content
Version: Next

Branching Strategy

User Story / Developer Branches​

Branch naming convention should be in this format

[type_of_ticket]/[team_name]/[ticket_number_without_prefix]_[description]

All should be lowercase

Each branch name has 3 sections as mentioned below:

Section 1 - Type of Ticket​

The first section is type of ticket/change.
It should be anything from this

  • task
  • bugfix
  • quickfix
  • hotfix

Section 2 - Team Name​

The second section is the team name.

For example:
miyagi, poh, avengers etc

Section 3 - Ticket Number and Description​

This section is JIRA Ticket number and description separated by underscore ( _ ) Ticket number is without prefix.

Just a ticket number isn't always an easy way to identify a branch, especially when you want to create multiple branches from a single story. So, we include some description.

This should be a short description of the changes you are making in the PR. Make the branch names meaningful so that others also can understand what you are conveying.

For example:

1235_fix_crash_at_login  
90909_initial_logout_implementation

Branch Name Examples​

task -> task/miyagi/1245_create_readme

bugfix -> bugfix/poh/1234_fix_dashboard

hotfix -> hotfix/avengers/1235_fix_crash_at_login

Important Note:

  • Your branch name should only contain lower case letters. No capitals at any point please.

  • Always delete the branch after its merged to develop.

Release Branches​

Branch Name should be in this format

release/[release_version]

Examples​

release/v1.0.0  
release/v12.4.0_rc1